home *** CD-ROM | disk | FTP | other *** search
/ Aminet 41 / Aminet 41 (2001)(Schatztruhe)[!][Feb 2001].iso / Aminet / util / wb / yStart.lha / yStart / yStart.txt < prev    next >
Text File  |  2000-12-04  |  9KB  |  232 lines
  1.                  yStart - Start menu for standard WB icons
  2.                  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  3.  
  4. Introduction
  5. ------------
  6. Like everybody who have to use Windows regularly, I saw day after day that
  7. the Amiga WB's way of starting programs, opening/closing drawers is often
  8. inefficient compared to the Start menu of Windows. I felt that the Amiga
  9. needs something similar.
  10.  
  11. On the other hand, I never really liked launcher programs based on some
  12. kind of configuration, such as Win95's secondary shortcut hierarchy not to
  13. mention the many Start buttons on the Amiga requiring application presets.
  14. What is this redundant information for, when I already have a carefully
  15. created disk hierarchy, prepared for GUI use with Amiga's .info files? All
  16. I wanted is a better way to use them.
  17.  
  18. It appears that I'm almost alone with this opinion. I waited patiently for
  19. a program like yStart, until I got the feeling that unless I write it
  20. myself, no such program will appear in this millennium. :-) (No, I don't
  21. like 2001, we should not propagate this 0-1 error through our entire
  22. history.)
  23.  
  24.  
  25. Requirements
  26. ------------
  27. - AmigaOS 2 (V37)
  28. - 40k hd space and 30k of memory :)
  29.  
  30.  
  31. Installation
  32. ------------
  33. Copy the yStart drawer anywhere you want. The program itself can also be
  34. dragged into WBStartup.
  35.  
  36.  
  37. Starting the program
  38. --------------------
  39. yStart is a standalone executable that can be started from both CLI and WB.
  40. The CLI arguments and WB tooltypes are the same, as follows:
  41.  
  42. - CX_POPKEY (string, defaults to "ctrl esc")
  43.   Specifies the program's hotkey using standard string representation.
  44.  
  45. - CX_PRIORITY (integer, defaults to 0)
  46.   The commodity priority.
  47.  
  48. - ICONMODE (OFF/ORIG/HALVED/LIMITY/LIMITXY, defaults to LIMITXY)
  49.   Determines the way yStart displays icons. Possible values:
  50.   - OFF
  51.     No icon display, fastest mode. (Some icons are still loaded, e.g. to
  52.     get the "show all" flag for drawers.)
  53.   - ORIG
  54.     Icons are displayed in original size. Line height varies.
  55.   - HALVED
  56.     Icons are displayed in half size. Line height varies.
  57.   - LIMITY
  58.     Icons are scaled down to fit within the text height of a line.
  59.   - LIMITXY
  60.     Icons are scaled down to fit within the text height of a line and a
  61.     a preset horizontal space, whichever is narrower. This mode is almost
  62.     as fast as the iconless mode, since the contents of the drawer can
  63.     start to display without waiting for all icons to load.
  64.  
  65. - ICONXYRATIO (integer, defaults to 280)
  66.   The ratio between the width and height of the icon space in LIMITXY mode.
  67.   Measured in percents (a value of 200 means the icon space is twice as
  68.   wide as tall). There is an additional 1.5 times horizontal adjustment for
  69.   screens with "tall dots".
  70.  
  71. - PLACEMENT (TOP/BOTTOM, defaults to TOP)
  72.   Determines whether the start button should be placed at the top or at the
  73.   bottom of the screen. If an exact position is given with POSX/POSY, it
  74.   still affects whether the the first level menu is dropped down or up.
  75.  
  76. - POSX (integer, defaults to -1)
  77.   The exact horizontal position of the start button. A value of -1 have no
  78.   effect (position is determined by PLACEMENT).
  79.  
  80. - POSY (integer, defaults to -1)
  81.   The exact vertical position of the start button. A value of -1 have no
  82.   effect (position is determined by PLACEMENT).
  83.  
  84. - SELIMAGES (YES/NO, defaults to YES)
  85.   Whether yStart should display highlighted images for selected items.
  86.  
  87. - TIMEOPEN (integer, defaults to 600)
  88.   The delay before auto-opening the selected drawer. Measured in
  89.   milliseconds.
  90.  
  91. - TIMECLOSE (integer, defaults to 600)
  92.   The delay before auto-closing an unused drawer. Measured in milliseconds.
  93.  
  94. - DEFAULTICONS (YES/NO, defaults to YES)
  95.   Whether yStart should retrieve default icons for iconless entries in
  96.   "show all" drawers. It is most useful if you are running a deficons-like
  97.   patch. Or, as a minimum you may want to create a default project icon and
  98.   set MultiView as its default tool.
  99.  
  100. - FAKEMASK (integer, defaults to $55aa55aa)
  101.   Default icons are grayed to indicate their "faked" nature. This 32 bit
  102.   value determines the amount of graying. It is a 8*4 pixels mask (the most
  103.   significant byte is the first row, and so on). Useful values could be
  104.   $55aa55aa (50% graying) or $5500aa00 (75% graying), etc.
  105.  
  106. - USERCMD (string, defaults to "")
  107.   This is a CLI command that can be executed on any object you pick,
  108.   extending the program's functionality with whatever you see fit. You can
  109.   simply "multiview", or execute scripts, "rx rexx:myprog.rexx", present
  110.   choices, etc. (Don't include quotes in WB tooltypes, unless you want them
  111.   in the command string.) The command will be complemented with the
  112.   object's name (ending with '/' in case of a drawer) and executed from the
  113.   object's parent directory. It is mapped to the right mouse button.
  114.  
  115. - UCFULLNAMES (YES/NO, defaults to NO)
  116.   Include the full path in the object's name when executing an USERCMD.
  117.  
  118.  
  119. User interface
  120. --------------
  121. yStart allows you to navigate through your disk and icon hierarchy just
  122. like Workbench does, but in an async loading dropdown menu based interface.
  123. There are three ways to operate the program: with the mouse, with the
  124. keyboard and as a commodity. Basic usage should be obvious, with the
  125. following options worth the mention:
  126.  
  127. - clicking on the start button opens/closes the entire menu
  128. - staying over a drawer opens it after some (TIMEOPEN) delay
  129. - clicking on a drawer forces it to open instantly, without the delay
  130. - clicking on a project/tool launches it
  131. - clicking in another window closes the entire menu
  132. - pressing ESC closes one level of the menu
  133. - pressing ENTER forces to open a drawer or launches a project/tool
  134. - pressing SPACE launches a project/tool
  135. - holding down SHIFT when activating an item keeps the menu open
  136. - pressing UP/DOWN moves the cursor
  137. - pressing LEFT/RIGHT moves the cursor or opens/closes drawers
  138. - holding down ALT when opening a drawer forces it to "show all" mode
  139. - pressing the commodity hotkey pops up yStart with the first menu open
  140. - removing the commodity quits the program
  141.  
  142. Delayed opening and closing of drawers is disabled during keyboard
  143. operation.
  144.  
  145. Holding down SHIFT is only effective if the launched program does not
  146. immediately open and activate a window (which equals to clicking away from
  147. yStart).
  148.  
  149. Holding down ALT only affects drawers opened by a mouseclick or by pressing
  150. ENTER, etc. It does not affect delayed auto-opening, although it is
  151. possible to use click / ALT+click on an opened drawer to toggle its forced
  152. "show all" status.
  153.  
  154. Quitting yStart is only possible when there are no WB-mode launched
  155. programs left running. Programs with the CLI tooltype (or iconless programs
  156. from "show all" drawers) doesn't count.
  157.  
  158.  
  159. Technical notes
  160. ---------------
  161. In the OFF and LIMITXY modes yStart needs to rely on some guesses as there
  162. are no icons loaded before laying out and opening a window. If a .info file
  163. does not have a corresponding file or directory entry, it is assumed to be
  164. a tool/project (and not a drawer) icon.
  165.  
  166. If yStart is started from CLI, the current path is used when searching for
  167. default tools. If it is started from WB, it copies the Workbench path.
  168.  
  169. The entire program was written in Secal.
  170.  
  171.  
  172. Known issues
  173. ------------
  174. On some Picasso cards the program stops at an internal safety check.
  175. This seems to be caused by the Picasso driver software: when scaling, it
  176. creates incorrect (one pixel wider than requested) images.
  177.  
  178.  
  179. Copyright
  180. ---------
  181. The yStart archive and all files it contains are copyright (c) 1999, 2000
  182. Makrai József. All rights reserved. These files may not be distributed in
  183. any form other than this archive.
  184.  
  185.  
  186. Distribution
  187. ------------
  188. Every project promises to be less work at first sight. yStart is no
  189. exception: it took me quite more work than I expected. For this reason, it
  190. is distributed as shareware. If you like it and use it, you should
  191. register. The reg fee is 2 euros :) (or equivalent amount in your local
  192. currency).
  193.  
  194.  
  195. Disclaimer
  196. ----------
  197. The executable and documentation are provided "as-is", without warranty of
  198. any kind, either expressed or implied. All use is at your own risk. No
  199. liability or responsibility for incidential or consequential damages is
  200. assumed.
  201.  
  202.  
  203. Author
  204. ------
  205. Name:     Makrai József
  206. E-mail:   tdsdev@matavnet.hu
  207. Address:  Budapest 1041 Deák u. 67. fsz. 2.
  208.           Hungary
  209.  
  210.  
  211. History
  212. -------
  213. 1.0 (1999 Dec 22)
  214.   * Initial release.
  215.  
  216. 1.1 (2000 Oct 16)
  217.   * Minor update from a lazy author.
  218.   - Fixed a bug that caused "show all" drawers to contain double entries
  219.     for files/drawers with icons (in nondefault ICONMODEs).
  220.   + Added the ALT key option for opening drawers.
  221.  
  222. 1.2 (2000 Dec 4)
  223.   * Somewhat richer update. Just don't expect development to carry on at
  224.     this rate. ;)
  225.   - Fixed a pointer bug. (Harmless under normal Kickstarts, but caused
  226.     trouble if exec's AllocVec was patched.)
  227.   + Added support for OS3.5 icon.library extensions.
  228.   + Added support for default icons. New options: DEFAULTICONS, FAKEMASK.
  229.   + Added USERCMD and UCFULLNAMES options.
  230.   + Minor changes.
  231.  
  232.